Unify VFS interfaces by rodinaarssen · Pull Request #2641 · usethesource/rascal

rodinaarssen · 2026-02-11T09:41:23Z

…IResolverRegistry

… a port during start-up

codecov · 2026-02-11T09:47:29Z

Codecov Report

❌ Patch coverage is 4.85981% with 509 lines in your changes missing coverage. Please review.
✅ Project coverage is 46%. Comparing base (53d2faa) to head (7dc8080).

Files with missing lines	Patch %	Lines
...mpl/uri/remote/RemoteExternalResolverRegistry.java	0%	234 Missing ⚠️
...rascalmpl/uri/remote/RascalFileSystemServices.java	0%	59 Missing ⚠️
.../uri/remote/jsonrpc/ISourceLocationChangeType.java	0%	22 Missing ⚠️
...mpl/uri/remote/jsonrpc/ISourceLocationChanged.java	0%	17 Missing ⚠️
.../org/rascalmpl/uri/remote/jsonrpc/CopyRequest.java	0%	16 Missing ⚠️
...rg/rascalmpl/uri/remote/jsonrpc/RenameRequest.java	0%	14 Missing ⚠️
src/org/rascalmpl/uri/URIResolverRegistry.java	31%	10 Missing and 3 partials ⚠️
...scalmpl/uri/vfs/IRemoteResolverRegistryServer.java	0%	13 Missing ⚠️
...org/rascalmpl/uri/remote/jsonrpc/WatchRequest.java	0%	12 Missing ⚠️
...rascalmpl/uri/remote/jsonrpc/WriteFileRequest.java	0%	12 Missing ⚠️
... and 17 more

Additional details and impacted files

@@           Coverage Diff            @@
##              main   #2641    +/-   ##
========================================
- Coverage       46%     46%    -1%     
+ Complexity    6737    6736     -1     
========================================
  Files          794     814    +20     
  Lines        65923   66406   +483     
  Branches      9888    9927    +39     
========================================
- Hits         30858   30857     -1     
- Misses       32684   33156   +472     
- Partials      2381    2393    +12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…e in rascal-lsp

toinehartman

All of this (and the companion PR usethesource/rascal-language-servers#967) look like a nice unification and clean-up of interfaces.

src/org/rascalmpl/uri/remote/RemoteExternalResolverRegistry.java

DavyLandman

It's making progress, but it's not there yet.

src/org/rascalmpl/uri/remote/RemoteExternalResolverRegistry.java

src/org/rascalmpl/uri/vfs/IRemoteResolverRegistry.java

src/org/rascalmpl/uri/URIResolverRegistry.java

…rver methods

…nted it in RascalFileSystemServices

…locks

…Type and aligned uses of the interfaces

sonarqubecloud · 2026-04-08T14:05:27Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

src/org/rascalmpl/uri/remote/RascalFileSystemServices.java

DavyLandman · 2026-04-09T07:37:32Z

src/org/rascalmpl/uri/remote/RascalFileSystemServices.java

+    }
+
+    @Override
+    public CompletableFuture<FileWithType[]> list(ISourceLocationRequest req) {


this is the only method that doesn't follow the URIInputResolver style of listing entries. I think this is because of VS Code that wants this information? but we should document this in the interface definition why we took this detour.

Yes, that's indeed what VS Code expects. Alternatively, we could do this the Rascal way (provide names only, no isDirectory boolean) and manually iterate over the listing with from the TS side

src/org/rascalmpl/uri/remote/RemoteExternalResolverRegistry.java

DavyLandman · 2026-04-09T07:44:40Z

src/org/rascalmpl/uri/remote/RemoteExternalResolverRegistry.java

+                    var data = (JsonPrimitive) error.getData();
+                    if (data.isString()) {
+                        switch (data.getAsString()) {
+                            case "FileExists": // fall-through
+                            case "EntryExists":
+                                return new FileAlreadyExistsException(error.getMessage());
+                            case "FileNotFound": // fall-through
+                            case "EntryNotFound":
+                                return new NoSuchFileException(error.getMessage());
+                            case "FileNotADirectory": // fall-through
+                            case "EntryNotADirectory":
+                                return new NotDirectoryException(error.getMessage());
+                            case "FileIsADirectory": // fall-through
+                            case "EntryIsADirectory":
+                                return new IOException("File is a directory: " + error.getMessage());
+                            case "NoPermissions":
+                                return new AccessDeniedException(error.getMessage());


I think we should move this strings & matching to VS Code, and have extra numeric cases that our interfaces enforces? Such that we have dedicated error codes.

Also, shouldn't those error codes be part of the contract instead of private numbers? Like an enum somewhere?

I'm thinking of the next implementation of the VFS, like for neovim for example, how much is documented, and how much is VS Code specific. The goal is to have the least amount of VS Code details leak into our design.

DavyLandman · 2026-04-09T07:46:19Z

src/org/rascalmpl/uri/remote/RemoteExternalResolverRegistry.java

+            case JsonRpcErrorCode_NativeRascal:
+                return new IOException("Rascal native schemes should not be forwarded");
+            default:
+                return new IOException("Missing case for: " + error);


I think we should say: "unkown IO exception: " + error + " data: "+ error.getData()

src/org/rascalmpl/uri/remote/RemoteExternalResolverRegistry.java

rodinaarssen added 24 commits January 7, 2026 15:43

Added an interface for a remote resolver registry

51b6393

Ported over FileAttributesResult from rascal-lsp

8adb46e

Merge branch 'main' into unify-vfs-interfaces

3cb33d9

Renamed fallback to external in WatchRegistry

f300250

Fixed layout issues

052ae18

Changed URI to ISourceLocation in remote resolver interface

513ffb3

Removed FallbackResolver in favor of external resolver registry in UR…

a144fe5

…IResolverRegistry

Removed method from remote interface

842881a

Added IExternalResolverRegistry interface

3284a32

Added client side for remote resolver registry

16c4bb2

RascalShell connects to external resolver registry when provided with…

9fe54a6

… a port during start-up

Merge branch 'main' into unify-vfs-interfaces

82d2ae9

Merge branch 'main' into unify-vfs-interfaces

177f099

Using new GsonUtils configuration function

d494609

Merge remote-tracking branch 'origin/main' into unify-vfs-interfaces

01d2b66

Merge branch 'main' into unify-vfs-interfaces

8febaae

Merge branch 'main' into unify-vfs-interfaces

f6328c8

Merge branch 'main' into unify-vfs-interfaces

9490e8c

RemoteExternalResolverRegistry now correctly throws plain IOExceptions

8cebae8

Ported over NamedThreadPool from rascal-lsp

b25f48c

Ported over Watch-related classes from rascal-lsp

387b853

Working on implementing remote watches

f0de47f

Merge remote-tracking branch 'origin/main' into unify-vfs-interfaces

0c56761

Merge remote-tracking branch 'origin/main' into unify-vfs-interfaces

20f6541

rodinaarssen added 3 commits February 11, 2026 13:27

Ported over Lazy from rascal-lsp

a57d1c3

Reinstated directory listing cache for jsonrpc that was present befor…

88a6696

…e in rascal-lsp

Reinstated handling of native jsonrpc error codes from rascal-lsp

2d1c2cc

toinehartman reviewed Feb 11, 2026

View reviewed changes

src/org/rascalmpl/uri/remote/RemoteExternalResolverRegistry.java Outdated Show resolved Hide resolved

src/org/rascalmpl/uri/remote/RemoteExternalResolverRegistry.java Show resolved Hide resolved

DavyLandman requested changes Feb 17, 2026

View reviewed changes

rodinaarssen added 20 commits April 3, 2026 14:37

Removed throwing default implementations of IRemoteResolverRegistrySe…

c5c9668

…rver methods

Added copy to the IRemoteResolverRegistryServer interface and impleme…

8aaede2

…nted it in RascalFileSystemServices

Implemented missing methods in RascalFileSystemServices

eb77334

Removed locks in favor of double invalidation to avoid potential dead…

ad5db56

…locks

Fixed indentation

aede048

Improved logic in isDirectory and isFile

1b7c9db

Watch now uses the remote call wrapper function

b2e358e

Watchers class is now private

714ed81

Improved locking logic around registration of external resolver registry

fd57777

Rewrote remote watch

aec8c40

Added comment

f73c360

RemoteExternalResolverRegistry now uses a single tread pool

eaf9cb0

Merge remote-tracking branch 'origin/main' into unify-vfs-interfaces

84acf0c

Removed checker framework annotations from request/response classes

58d4673

Made all members of request/response classes final

5d2bef9

Removed enum values from ISourceLocationWatcher.ISourceLocationChange…

8d6ad8b

…Type and aligned uses of the interfaces

Catching socketException around available

1124c93

Using correct translation for ISourceLocationChanged

a03b929

Added callback to Base64EncodingOutputStream that runs after close

f1ad341

Avoiding extra allocation of byte array by providing a callback

e549d40

rodinaarssen requested a review from DavyLandman April 8, 2026 11:11

rodinaarssen added 7 commits April 8, 2026 15:26

Layout

25a1f53

Reordered some interfaces and renames some parameters for uniformity

77bb3d0

Added license header

5a67222

Layout

4db63e4

Unused imports

0261916

Removed another Nullable annotation from request class

a4514cf

Removed nullable annotation from RemoteExternalResolverRegistry

7dc8080

DavyLandman reviewed Apr 9, 2026

View reviewed changes

Conversation

rodinaarssen commented Feb 11, 2026 • edited by toinehartman Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

toinehartman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

DavyLandman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Apr 8, 2026

Quality Gate passed

Uh oh!

Uh oh!

Uh oh!

DavyLandman Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

rodinaarssen Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

DavyLandman Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

DavyLandman Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rodinaarssen commented Feb 11, 2026 •

edited by toinehartman

Loading

codecov bot commented Feb 11, 2026 •

edited

Loading